receiveLatestSimulationResult
Receive latest simulation result which can be stored in own OSim Manager instance
Path Parameters
- requestId string requiredExample: 8d628899-3e6f-4666-91c3-74ee7ab88b2b
- application/json
Request Body
- description string required
Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
- runId string required
Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
- comment string required
Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
- expirationTimestamp string required
Possible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Describes a Property which contains the date and time with an optional timezone.
owner object
Characteristic describing the Scenario Owner
bpnsProperty string requiredPossible values: Value must match regular expression
^BPNS[a-zA-Z0-9]{12}$
The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.
- dataQuality number required
Possible values: [
0
,1
,2
,3
,4
,5
]Possible values determining data quality
shipments object[] required
List of shipments contained in the simulation
shipmentId string requiredDescribes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
destination object
Characteristic describing the Scenario Owner
bpnsProperty string requiredPossible values: Value must match regular expression
^BPNS[a-zA-Z0-9]{12}$
The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.
destinationTimestamp string requiredPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Describes a Property which contains the date and time with an optional timezone.
recipient object
Characteristic describing the Scenario Owner
bpnsProperty string requiredPossible values: Value must match regular expression
^BPNS[a-zA-Z0-9]{12}$
The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.
recipientTimestampPlanned string requiredPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Describes a Property which contains the date and time with an optional timezone.
splittingAllowed boolean requiredRepresents a boolean value (i.e. a "flag").
logistics object
Characteristic describing the Scenario Owner
bpnsProperty string requiredPossible values: Value must match regular expression
^BPNS[a-zA-Z0-9]{12}$
The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.
preceding object
Characteristic describing the Scenario Owner
bpnsProperty string requiredPossible values: Value must match regular expression
^BPNS[a-zA-Z0-9]{12}$
The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.
handlingUnits object[] required
List of handling units included in the shipment
handlingUnitId string requiredDescribes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
name string requiredDescribes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
volume number requiredVolumetric value determining the volume of the handling unit
weight number requiredAmount of weight of the handling unit
amount number requiredPossible values:
>= 1
Number describing handling units with identical pieces
batches object[] required
List of material batches
batchSerialNumber string requiredDescribes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
materialNumber string requiredDescribes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
materialName string requiredDescribes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
materialHazardousGoods boolean requiredRepresents a boolean value (i.e. a "flag").
batchExpirationTimestamp string requiredPossible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Describes a Property which contains the date and time with an optional timezone.
quantity number requiredNumber of materials contained within a handling unit
unitOfMeasurement string requiredPossible values: [
KG
,Liter
,Piece
]Possible options for units of measurement
batchNumber string requiredDescribes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
batchOrderId string requiredDescribes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.
- timestamp string required
Possible values: Value must match regular expression
-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Describes a Property which contains the date and time with an optional timezone.
- 200
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 500
- 501
OK
- text
- Schema
Schema
- string
Bad request
- text
- Schema
Schema
- string
Unauthorized
- text
- Schema
Schema
- string
Payload is empty
- text
- Schema
Schema
- string
Forbidden
- text
- Schema
Schema
- string
Payload structure unknown
- text
- Schema
Schema
- string
Method not allowed
- text
- Schema
Schema
- string
Payload content invalid
- text
- Schema
Schema
- string
Internal server error
- text
- Schema
Schema
- string
Service unavailable
- text
- Schema
Schema
- string